home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_300 / 399_01 / mined.hel < prev    next >
Text File  |  1993-08-03  |  24KB  |  533 lines
  1. MINED                EDITOR                MINED
  2.  
  3.  
  4. NAME
  5.     mined - a text editor
  6.  
  7. SYNTAX
  8.     mined [ -<options> ] [ +linenumber ] [ filename ] [ more filenames ... ]
  9.  
  10.  
  11. DESCRIPTION
  12.     An easy-to-use and natural in appearance text editor.
  13.     Its original version was designed for Andrew S Tanenbaum's operating 
  14.     system Minix.
  15.  
  16.     Startup features:
  17.     - with given file name (as usual) or multiple file names
  18.     - without given file name
  19.     - reading from a pipe (reading text from standard input)
  20.     - writing into a pipe (writing edited text to standard output)
  21.     Examples:
  22.     mined x        - edits the file x
  23.     mined x y z    - edits files x, y, and z
  24.     cmd | mined    - edits the output of "cmd", file name for saving 
  25.               can be given later
  26.     mined x > y    - takes the contents of file x and edits it 
  27.               for writing into y
  28.     mined | mail nn    - edits a text to be mailed
  29.     cmd1 | mined | cmd2 - modifies text in between a pipe from 
  30.                 program cmd1 (output) to cmd2 (as input)
  31.     Startup options:
  32.     +number    Mined positions to the given line number.
  33.     -v    Mined starts in view only mode. The text cannot be modified.
  34.     -m    ESC ESC does not exit mined, but proceed to the next file.
  35.         (currently default setting)
  36.     -p    Enables provisions for proportional display fonts. (I have 
  37.         not yet encountered a terminal emulation which handles this 
  38.         well, see comments in mined.new.)
  39.     -r    Ignore CR characters (so strip them at line ends).
  40.         I.e., read MSDOS text on Unix machines.
  41.     -R    Take CR only for newline. I.e., read MacIntosh text on 
  42.         MSDOS or Unix machines.
  43.     -C    Enables use of Chinese or other 16-bit character set. A byte 
  44.         with high bit set is regarded as the first of a two-byte 
  45.         character sequence and will not be separated in certain 
  46.         mined operations. This works well, e.g., with the Chinese 
  47.         xterm version, cxterm.
  48.     -B    Backspace deletes left, Delete deletes right.
  49.     -W    Select WordStar key function layout. This includes many 
  50.         functions of the ^K, ^O, and ^Q menus.
  51.     -s    Display option: Stay with cursor in top line after page down 
  52.         or bottom line after page up instead of center line.
  53.     -S    Display option: Use scrolling for page up/down.
  54.     -dn    Display option: Apply delay between lines of page output to 
  55.         achieve nice effective display build-up, starting from the 
  56.         new cursor position proceeding to the screen edges.
  57.         If n lies between '0' and '9', the respective number of 
  58.         milliseconds is applied between display of two lines.
  59.         If n='0', still an output flush is performed.
  60.         If n='-', no delay at all is applied though still the order 
  61.         of display output is from cursor position to edges.
  62.         Default: '-' in the Unix version, '9' in the MSDOS version.
  63.         To achieve paging speed at the keyboard repeat rate but still 
  64.         have a taste of the build-up effect, a value of '5' or '6' 
  65.         is suitable on my MSDOS system.
  66.     These options are also looked for in the environment variable MINED.
  67.     Some options can also be set by the existence of further variables:
  68.     MINEDPROP    sets -p
  69.     MINEDCHIN    sets -C
  70.     MINEDMAC    sets -R
  71.     MINEDWS        sets -W
  72.  
  73.   Basic functionality
  74.     Mined is always in insert mode. Commands are single control characters, 
  75.     double key commands starting with ESCAPE, and a collection of function 
  76.     keys (currently installed for the VT220, SUN, and Iris terminals). 
  77.     As a specialty, note the prefixing 'HOP KEY' which stretches the effect 
  78.     of some cursor and screen motion commands just as you would expect; this 
  79.     provides for more command flexibility without too much key remembering. 
  80.     Control key layout in the current version is 'geographically' oriented 
  81.     on the left side of the keyboard for the main motion commands, an idea 
  82.     probably originating from the 'WordMaster' and 'WordStar' editors. 
  83.     On SUN terminals, also the right-hand cursor block is assigned the 
  84.     most important movement functions as follows:
  85.                         +------+-------+------+
  86.                         | LnDn |   ^   | PgUp |
  87.                         +------+-------+------+
  88.                         |  <-  |  HOP  |  ->  |
  89.                         +------+-------+------+
  90.                         | LnUp |   v   | PgDn |
  91.                         +------+-------+------+
  92.  
  93.     Note that line-feeds (end-of-line character) are treated like any 
  94.     ordinary character except that they cannot occur in search strings.
  95.     This drawback (not to be able to search / replace lineends naturally) 
  96.     seems to be a tradition of line-oriented unix tools and I was not 
  97.     willing to spend that much time going into very special parts of mined.
  98.  
  99.     Every care has been taken to prevent loss of the edited text in case 
  100.     of save errors or accidental quit commands etc. Also, if a command is 
  101.     given to write to a file not previously read in, mined prompts for 
  102.     confirmation.
  103.     In the "write to standard output" mode, only one save to standard output 
  104.     can be performed, so there is a problem in the case that more than one 
  105.     saving actions occur; the first save (whether by a write, edit, 
  106.     or suspend command) of the buffer is written to standard output, 
  107.     any subsequent one is treated as usual (with empty file name).
  108.  
  109.     Before regarding the command keys and their functions, 
  110.     note the following general remarks:
  111.  
  112.   The HOP function
  113.     This function, triggered by any of the HOP keys, fortifies (or modifies) 
  114.     functions as follows. To achieve the combined function, first press 
  115.     any key that is assigned the HOP function, then any key assigned 
  116.     the second function:
  117.  
  118.     HOP - char left            move cursor to start of current line
  119.     HOP - char right            move cursor to end of current line
  120.     HOP - line up            move cursor to top of screen
  121.     HOP - line down            move cursor to bottom of screen
  122.     HOP - scroll up            scroll half a screen up
  123.     HOP - scroll down            scroll half a screen down
  124.     HOP - page up            move to start of file
  125.     HOP - page down            move to end of file
  126.     HOP - word left            move cursor to previous ";" or "."
  127.     HOP - word right            move cursor to next ";" or "."
  128.     HOP - delete tail of line/lineend    delete whole line
  129.     HOP - delete whole line        delete tail of line
  130.     HOP - delete previous character    delete beginning of line
  131.     HOP - set mark            go to mark
  132.     HOP - search            search for current identifier
  133.     HOP - search next            repeat previous (last but one) search
  134.     HOP - copy/cut            copy or cut, but append to buffer
  135.     HOP - save buffer            save buffer, but append to file
  136.     HOP - paste buffer            paste "inter-window buffer", 
  137.             which is the last saved buffer by any invocation 
  138.             of mined on the same machine by the same user.
  139.     HOP - edit next file        edit last file
  140.     HOP - edit previous file        edit first file
  141.     HOP - suspend            suspend without writing file
  142.  
  143.   Typing in 8-bit characters in absence of appropriate keyboard
  144.     Some function keys can be used as prefix keys to change the character 
  145.     assigned to the following key to a diacritic or special character.
  146.     (MSDOS remark: the prefix and compose functions have been defined as 
  147.     appropriate for the "Codepage" 850. Some of the characters shown below 
  148.     are meaningless as letters in the "default Codepage" 437.)
  149.  
  150.     Six diacritic prefix functions are provided:
  151.     grave: adds grave accent where applicable: αΦ∞≥∙ └╚╠╥┘
  152.     R1 (sun)
  153.     shift-F6 (pc)
  154.     circumflex: adds circumflex accent where applicable: ΓΩε⌠√ ┬╩╬╘█
  155.     R2 (sun)
  156.     cntrl-F6 (pc)
  157.     acute: adds acute accent where applicable: ßΘφ≤·² ┴╔═╙┌▌
  158.     R3 (sun)
  159.     F6 (pc)
  160.     diaeresis: adds diaeresis where applicable: Σδ∩÷ⁿ  ─╦╧╓▄
  161.     R4 (sun)
  162.     F7 (pc)
  163.     F6 (vt100)
  164.     tilde: adds tilde where applicable: π±⌡ ├╤╒
  165.     R5 (sun)
  166.     shift-F7 (pc)
  167.     angstrom: a╗σ, A╗┼, e╗µ, E╗╞, o╗°, O╗╪
  168.     R6 (sun)
  169.     cntrl-F7 (pc)
  170.     Where these rules do not apply, any of these prefix keys makes the 
  171.     following default transformations:
  172.     s╗▀, c╗τ, C╗╟, n╗±, N╗╤, d╗≡, D╗╨, p╗■, P╗▐, m╗╡,
  173.     l╗ú, L╗ú, /╗ó, $╗ó, Y╗Ñ, X╗ñ, &╗º, #╗╢, !╗í, ?╗┐,
  174.     <╗½, >╗╗, x╗╫, :╗≈, +╗▒, 0╗░, 1╗╣, 2╗▓, 3╗│,
  175.     *╗╖, .╗╖, ,╗╕, "╗¿, '╗┤, _╗», -╗¡, \╗¼, |╗ª
  176.  
  177.     In addition, the enter-control-code prefix (^V (WS: ^P)) has been 
  178.     extended to compose characters if the first following key typed in 
  179.     is a character resembling an accent ma